<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataModelBdb: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="data_models.html" title="Data handling">
<link rel="prev" href="GdaDataModelLdap.html" title="GdaDataModelLdap">
<link rel="next" href="GdaDataModelDir.html" title="GdaDataModelDir">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgda-5.0-GdaDataModelBdb.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="data_models.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaDataModelLdap.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaDataModelDir.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgda-5.0-GdaDataModelBdb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdaDataModelBdb.top_of_page"></a>GdaDataModelBdb</span></h2>
<p>GdaDataModelBdb — GdaDataModel to access Berkeley DB database contents</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaDataModelBdb.html#gda-data-model-bdb-new" title="gda_data_model_bdb_new ()">gda_data_model_bdb_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaDataModelBdb.html#gda-data-model-bdb-get-errors" title="gda_data_model_bdb_get_errors ()">gda_data_model_bdb_get_errors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaDataModelBdb.html#gda-data-model-bdb-clean-errors" title="gda_data_model_bdb_clean_errors ()">gda_data_model_bdb_clean_errors</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb">GdaDataModelBdb</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdbClass" title="struct GdaDataModelBdbClass">GdaDataModelBdbClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdbPrivate" title="GdaDataModelBdbPrivate">GdaDataModelBdbPrivate</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.description"></a><h2>Description</h2>
<p>The <a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object allows to access the contents of a Berkeley DB database as a
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.</p>
<p>By default the resulting GdaDataModel contains only two columns (named "key" and "data") of type
GDA_TYPE_BINARY, but this object can be subclassed to convert the key or data part of a BDB record
into several columns (implement the <code class="function">create_key_columns()</code>, <code class="function">create_data_columns()</code>, <code class="function">get_key_part()</code>, and <code class="function">get_data_part()</code> 
virtual methods).</p>
<p>Note: this type of data model is available only if the Berkeley DB library was found at compilation time.</p>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-data-model-bdb-new"></a><h3>gda_data_model_bdb_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *
gda_data_model_bdb_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                        <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *db_name</code></em>);</pre>
<p>Creates a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object to access the contents of the Berkeley DB file <em class="parameter"><code>file</code></em>
,
for the database <em class="parameter"><code>db_name</code></em>
 if not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<div class="refsect3">
<a name="gda-data-model-bdb-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>name of the file containing the database</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>db_name</p></td>
<td class="parameter_description"><p>the name of the database within <em class="parameter"><code>filename</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-model-bdb-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-bdb-get-errors"></a><h3>gda_data_model_bdb_get_errors ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_data_model_bdb_get_errors (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);</pre>
<p>Get the list of errors which have occurred while using <em class="parameter"><code>model</code></em>
</p>
<div class="refsect3">
<a name="gda-data-model-bdb-get-errors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-data-model-bdb-get-errors.returns"></a><h4>Returns</h4>
<p>a read-only list of <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointers, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no error has occurred. </p>
<p><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GError][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-bdb-clean-errors"></a><h3>gda_data_model_bdb_clean_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_data_model_bdb_clean_errors (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);</pre>
<p>Reset the list of errors which have occurred while using <em class="parameter"><code>model</code></em>
</p>
<div class="refsect3">
<a name="gda-data-model-bdb-clean-errors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaDataModelBdb.html#GdaDataModelBdb" title="struct GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaDataModelBdb"></a><h3>struct GdaDataModelBdb</h3>
<pre class="programlisting">struct GdaDataModelBdb {
	GObject                 object;
	GdaDataModelBdbPrivate *priv;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelBdbClass"></a><h3>struct GdaDataModelBdbClass</h3>
<pre class="programlisting">struct GdaDataModelBdbClass {
	GObjectClass            parent_class;

	/* virtual methods */
	GSList                *(*create_key_columns)  (GdaDataModelBdb *model);
	GSList                *(*create_data_columns) (GdaDataModelBdb *model);
	GValue                *(*get_key_part)        (GdaDataModelBdb *model,

						       gpointer data, gint length, gint part);
	GValue                *(*get_data_part)       (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part);
	gboolean               (*update_key_part)     (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part,

						       const GValue *value, GError **error);
	gboolean               (*update_data_part)    (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part,

						       const GValue *value, GError **error);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelBdbPrivate"></a><h3>GdaDataModelBdbPrivate</h3>
<pre class="programlisting">typedef struct _GdaDataModelBdbPrivate GdaDataModelBdbPrivate;</pre>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaDataModelBdb.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>